currentsens.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef CURRENTSENS_H
#define CURRENTSENS_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define CURRENTSENS_NUM_CONVERSIONS             200

#define CURRENTSENS_ADC_RESOLUTION              0x0FFF
#define CURRENTSENS_VREF_2V5                    2.5
#define CURRENTSENS_VREF_3V3                    3.3
#define CURRENTSENS_VREF_5V                     5.0

#define CURRENTSENS_TIMEOUT_MS                  2000

#define CURRENTSENS_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define CURRENTSENS_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 // currentsens_set



#define CURRENTSENS_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.an   = MIKROBUS( mikrobus, MIKROBUS_AN );
 // currentsens_map // currentsens

typedef enum
{
    CURRENTSENS_DRV_SEL_ADC,              
    CURRENTSENS_DRV_SEL_SPI               
 
} currentsens_drv_t;

typedef struct
{
    analog_in_t  adc;                   
    spi_master_t spi;                   
 
    pin_name_t   chip_select;           
    currentsens_drv_t drv_sel;          
    float        vref;                  
    float        zero_curr_offset;      
    float        data_resolution;       
 
} currentsens_t;

typedef struct
{
    pin_name_t an;                      
    pin_name_t miso;                    
    pin_name_t mosi;                    
    pin_name_t sck;                     
    pin_name_t cs;                      
 
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
    
    analog_in_resolution_t resolution;  
    float                  vref;        
    currentsens_drv_t      drv_sel;     
 
} currentsens_cfg_t;

typedef enum
{
    CURRENTSENS_OK = 0,
    CURRENTSENS_ERROR = -1
 
} currentsens_return_value_t;


void currentsens_cfg_setup ( currentsens_cfg_t *cfg );

void currentsens_drv_interface_sel ( currentsens_cfg_t *cfg, currentsens_drv_t drv_sel );

err_t currentsens_init ( currentsens_t *ctx, currentsens_cfg_t *cfg );

err_t currentsens_read_raw_adc ( currentsens_t *ctx, uint16_t *raw_adc );

err_t currentsens_read_voltage ( currentsens_t *ctx, float *voltage );

err_t currentsens_read_voltage_avg ( currentsens_t *ctx, uint16_t num_conv, float *voltage_avg );

err_t currentsens_set_vref ( currentsens_t *ctx, float vref );

err_t currentsens_calib_offset ( currentsens_t *ctx );

err_t currentsens_calib_resolution ( currentsens_t *ctx, float calib_current );

err_t currentsens_read_current ( currentsens_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTSENS_H
 // currentsens
 
// ------------------------------------------------------------------------ END